de.cebis.moccapart.calendar.domain
Class CalendarComponent

java.lang.Object
  de.cebis.moccabox.domain.AbstractConceptualObject
      de.cebis.moccapart.calendar.domain.CalendarComponent

All Implemented Interfaces:

IPersistentConcept, java.io.Serializable

Direct Known Subclasses:

CalendarEvent, CalendarTask

public class CalendarComponent
extends AbstractConceptualObject
implements java.io.Serializable

Object representing an CalendarComponent.
The CalendarComponent-object encapsulates different methods, to store and retrieve the different attributes of a calendar component.
The CalendarComponent does not necessarily have to represent an object stored in the database, but can be instantiated with an ComponentSource-object as well.

Version:

0

Author:

Christian Weichelt

See Also:

Serialized Form

Field Summary

static int	NO_RIGHTS Keine Rechte, den Eintrag zu sehen.
static int	NO_STATUS Standard status for the component which signals that no status is given yet.
static int	OPAQUE The CalendarComponent is visible for others.
static java.lang.String	PROP_CALENDAR
static java.lang.String	PROP_CALENDARCOMPONENTCATEGORY
static java.lang.String	PROP_CLASSIFICATION
static java.lang.String	PROP_COMMENT
static java.lang.String	PROP_DESCRIPTION
static java.lang.String	PROP_DURATION
static java.lang.String	PROP_EDITABLE
static java.lang.String	PROP_LOCATION
static java.lang.String	PROP_MOVEABLE
static java.lang.String	PROP_ORGANISER
static java.lang.String	PROP_RELATEDCONCEPT
static java.lang.String	PROP_SEARCHFIELD
static java.lang.String	PROP_START
static java.lang.String	PROP_STARTTIME
static java.lang.String	PROP_STATUS
static java.lang.String	PROP_SUMMARY
static java.lang.String	PROP_TRANSPARENCY
static int	READ Das Recht, die Attribute eines CalendarComponent-Objektes zu lesen.
static int	STATUS_CANCELLED The CalendarComponent has been deleted
static int	STATUS_CONFIRMED The CalendarComponent has been confirmed
static int	STATUS_TENTATIVE The CalendarComponent is still tentative
static int	TIME_ONLY Das Recht, den belegten Zeitraum eines CalendarComponent-Objektes zu sehen.
static int	TRANSPARENT The CalendarComponent is not visible for others.
static int	WRITE Das Recht, die Attribute eines CalendarComponent-Objektes zu ändern.

Fields inherited from interface de.cebis.moccabox.domain.IPersistentConcept

PROP_CREATION_DATE, PROP_ID, PROP_LAST_EDIT_DATE, PROP_LAST_EDIT_USER

Constructor Summary

CalendarComponent()

CalendarComponent(java.lang.Long _iD)
Constructor for primary key

Method Summary

Calendar	getCalendar()
CalendarComponentCategory	getCategory()
java.lang.String	getClassification() Returns the classification of the CalendarComponent.
java.lang.String	getComment() Returns a comment for the CalendarComponent.
java.lang.String	getDescription() Returns a detailled description of the CalendarComponent.
java.lang.String	getDuration() Returns the duration of the CalendarComponent.
java.lang.String	getLocation() Returns the location where the CalendarComponent takes place.
IPersistentConcept	getOrganiser()
IPersistentConcept	getRelatedConcept()
java.lang.String	getSearchField()
java.util.Date	getStart() Returns the starting date of the CalendarComponent.
java.lang.String	getStartText() Returns a text formatted date.
java.lang.String	getStarttime()
java.lang.String	getStartTime() Returns the starting time of the CalendarComponent.
int	getStatus() Returns the specific status the CalendarComponent is in.
java.lang.String	getSummary() Returns the short title of the entry.
int	getTransp() Returns the specific transparency of the CalendarComponent.
int	getTransparency()
boolean	isEditable() Returns if the CalendarComponent is editable for the current user.
boolean	isMoveable() Returns if the CalendarComponent is moveable for the current user.
void	setCalendar(Calendar calendar)
void	setCategory(CalendarComponentCategory category)
void	setClassification(java.lang.String classification) Sets the classification of the CalendarComponent.
void	setComment(java.lang.String comment) Sets a comment for the CalendarComponent.
void	setDescription(java.lang.String description) Sets a detailled description of the CalendarComponent.
void	setDuration(java.lang.String duration) Sets the duration of the CalendarComponent.
void	setEditable(boolean editable) Sets if the CalendarComponent is editable for the current user.
void	setLocation(java.lang.String location) Sets the location where the CalendarComponent takes place.
void	setMoveable(boolean moveable) Sets if the CalendarComponent is moveable for the current user.
void	setOrganiser(IPersistentConcept organiser)
void	setRelatedConcept(IPersistentConcept relatedConcept)
void	setSearchField(java.lang.String searchField)
void	setStart(java.util.Date start) Sets the starting date and time of the CalendarComponent.
void	setStarttime(java.lang.String startTime)
void	setStartTime(java.lang.String startTime) Sets the starting time of the CalendarComponent.
void	setStatus(int status) Sets the specific status the CalendarComponent is in.
void	setSummary(java.lang.String title) Sets the short title of the entry.
void	setTransp(int transparency) Sets the specific transparency of the CalendarComponent.
void	setTransparency(int transparency)

Methods inherited from class de.cebis.moccabox.domain.AbstractConceptualObject

getCreationDate, getId, getLastEditDate, getVersion, setCreationDate, setId, setLastEditDate, setVersion

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TIME_ONLY

public static final int TIME_ONLY

Das Recht, den belegten Zeitraum eines CalendarComponent-Objektes zu sehen.

See Also:

Constant Field Values

READ

public static final int READ

Das Recht, die Attribute eines CalendarComponent-Objektes zu lesen.

See Also:

Constant Field Values

WRITE

public static final int WRITE

Das Recht, die Attribute eines CalendarComponent-Objektes zu ändern.

See Also:

Constant Field Values

NO_RIGHTS

public static final int NO_RIGHTS

Keine Rechte, den Eintrag zu sehen.

See Also:

Constant Field Values

TRANSPARENT

public static final int TRANSPARENT

The CalendarComponent is not visible for others.

See Also:

Constant Field Values

OPAQUE

public static final int OPAQUE

The CalendarComponent is visible for others.

See Also:

Constant Field Values

STATUS_CONFIRMED

public static final int STATUS_CONFIRMED

The CalendarComponent has been confirmed

See Also:

Constant Field Values

STATUS_TENTATIVE

public static final int STATUS_TENTATIVE

The CalendarComponent is still tentative

See Also:

Constant Field Values

STATUS_CANCELLED

public static final int STATUS_CANCELLED

The CalendarComponent has been deleted

See Also:

Constant Field Values

NO_STATUS

public static final int NO_STATUS

Standard status for the component which signals that no status is given yet.

See Also:

Constant Field Values

PROP_CALENDAR

public static final java.lang.String PROP_CALENDAR

See Also:

Constant Field Values

PROP_CALENDARCOMPONENTCATEGORY

public static final java.lang.String PROP_CALENDARCOMPONENTCATEGORY

See Also:

Constant Field Values

PROP_ORGANISER

public static final java.lang.String PROP_ORGANISER

See Also:

Constant Field Values

PROP_RELATEDCONCEPT

public static final java.lang.String PROP_RELATEDCONCEPT

See Also:

Constant Field Values

PROP_CLASSIFICATION

public static final java.lang.String PROP_CLASSIFICATION

See Also:

Constant Field Values

PROP_SUMMARY

public static final java.lang.String PROP_SUMMARY

See Also:

Constant Field Values

PROP_DESCRIPTION

public static final java.lang.String PROP_DESCRIPTION

See Also:

Constant Field Values

PROP_COMMENT

public static final java.lang.String PROP_COMMENT

See Also:

Constant Field Values

PROP_SEARCHFIELD

public static final java.lang.String PROP_SEARCHFIELD

See Also:

Constant Field Values

PROP_STATUS

public static final java.lang.String PROP_STATUS

See Also:

Constant Field Values

PROP_EDITABLE

public static final java.lang.String PROP_EDITABLE

See Also:

Constant Field Values

PROP_MOVEABLE

public static final java.lang.String PROP_MOVEABLE

See Also:

Constant Field Values

PROP_START

public static final java.lang.String PROP_START

See Also:

Constant Field Values

PROP_STARTTIME

public static final java.lang.String PROP_STARTTIME

See Also:

Constant Field Values

PROP_DURATION

public static final java.lang.String PROP_DURATION

See Also:

Constant Field Values

PROP_TRANSPARENCY

public static final java.lang.String PROP_TRANSPARENCY

See Also:

Constant Field Values

PROP_LOCATION

public static final java.lang.String PROP_LOCATION

See Also:

Constant Field Values

Constructor Detail

CalendarComponent

public CalendarComponent()

CalendarComponent

public CalendarComponent(java.lang.Long _iD)

Constructor for primary key

Method Detail

getSummary

public java.lang.String getSummary()

Returns the short title of the entry.

Returns:

Short title of the Entry.

setSummary

public void setSummary(java.lang.String title)

Sets the short title of the entry.

Parameters:

title - Short title of the Entry.

getClassification

public java.lang.String getClassification()

Returns the classification of the CalendarComponent.

Returns:

CalendarComponent is PUBLIC / CONFIDENTIAL / PRIVATE.

setClassification

public void setClassification(java.lang.String classification)

Sets the classification of the CalendarComponent.

Parameters:

classification - CalendarComponent is PUBLIC / CONFIDENTIAL / PRIVATE.

getLocation

public java.lang.String getLocation()

Returns the location where the CalendarComponent takes place.

Returns:

Location where the event takes place.

setLocation

public void setLocation(java.lang.String location)

Sets the location where the CalendarComponent takes place.

Parameters:

location - Location where the event takes place.

getDescription

public java.lang.String getDescription()

Returns a detailled description of the CalendarComponent.

Returns:

Description of the event.

setDescription

public void setDescription(java.lang.String description)

Sets a detailled description of the CalendarComponent.

Parameters:

description - Description of the event.

getComment

public java.lang.String getComment()

Returns a comment for the CalendarComponent.

Returns:

The CalendarComponent´s comment.

setComment

public void setComment(java.lang.String comment)

Sets a comment for the CalendarComponent.

Parameters:

comment - The CalendarComponent´s comment.

getStatus

public int getStatus()

Returns the specific status the CalendarComponent is in.

Returns:

Status the entry is in.

setStatus

public void setStatus(int status)

Sets the specific status the CalendarComponent is in.

Parameters:

status - Status the entry is in.

getTransp

public int getTransp()

Returns the specific transparency of the CalendarComponent.

Returns:

Returns OPAQUE if entry is visible for others than organizer. Otherwise, TRANSPARENT is returned.

setTransp

public void setTransp(int transparency)

Sets the specific transparency of the CalendarComponent.

Parameters:

transparency - OPAQUE if entry is visible for others than organizer. Otherwise, TRANSPARENT must be set.

getDuration

public java.lang.String getDuration()

Returns the duration of the CalendarComponent. Example: P1Y2M3DT4H30M12S means the duration of the enty is of 1 year, 2 months, 3 days, 4 hours, 30 minutes and 12 seconds.

Returns:

Duration of the CalendarComponent.

setDuration

public void setDuration(java.lang.String duration)

Sets the duration of the CalendarComponent. Example: P1Y2M3DT4H30M12S means the duration of the enty is of 1 year, 2 months, 3 days, 4 hours, 30 minutes and 12 seconds.

Parameters:

duration - Duration of the CalendarComponent.

getStart

public java.util.Date getStart()

Returns the starting date of the CalendarComponent.

Returns:

Date that the entry starts.

getStartText

public java.lang.String getStartText()

Returns a text formatted date.

Returns:

The Start date formatted as text.

setStart

public void setStart(java.util.Date start)

Sets the starting date and time of the CalendarComponent.

Parameters:

start - Date and time that the entry starts.

getStartTime

public java.lang.String getStartTime()

Returns the starting time of the CalendarComponent.

Returns:

Time that the entry starts.

setStartTime

public void setStartTime(java.lang.String startTime)

Sets the starting time of the CalendarComponent.

Parameters:

startTime - Time that the entry starts.

isEditable

public boolean isEditable()

Returns if the CalendarComponent is editable for the current user.

Returns:

True, if the entry is editable. False, otherwise.

setEditable

public void setEditable(boolean editable)

Sets if the CalendarComponent is editable for the current user. If entry is from a calendar with 'read-permission' only, the entry is not editable.

Parameters:

editable - True, if the entry is editable. False, otherwise.

isMoveable

public boolean isMoveable()

Returns if the CalendarComponent is moveable for the current user.

Returns:

True, if the entry is moveable. False, otherwise.

setMoveable

public void setMoveable(boolean moveable)

Sets if the CalendarComponent is moveable for the current user.

Parameters:

moveable - True, if the entry is moveable. False, otherwise.

setSearchField

public void setSearchField(java.lang.String searchField)

getSearchField

public java.lang.String getSearchField()

getCalendar

public Calendar getCalendar()

setCalendar

public void setCalendar(Calendar calendar)

getCategory

public CalendarComponentCategory getCategory()

setCategory

public void setCategory(CalendarComponentCategory category)

getOrganiser

public IPersistentConcept getOrganiser()

setOrganiser

public void setOrganiser(IPersistentConcept organiser)

getRelatedConcept

public IPersistentConcept getRelatedConcept()

setRelatedConcept

public void setRelatedConcept(IPersistentConcept relatedConcept)

getStarttime

public java.lang.String getStarttime()

setStarttime

public void setStarttime(java.lang.String startTime)

getTransparency

public int getTransparency()

setTransparency

public void setTransparency(int transparency)